Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update storybook config and convert stories to work with addon-docs #6532

Merged
merged 16 commits into from
Jul 27, 2020
Merged

Update storybook config and convert stories to work with addon-docs #6532

merged 16 commits into from
Jul 27, 2020

Conversation

joshblack
Copy link
Contributor

This PR introduces a couple of updates to storybook, namely:

  • Update the configuration files addons.js to manager.js and config.js to preview.js to match the migration guide
  • Add main.js file as new entrypoint for configuration
  • Add support for @storybook/addon-docs and @storybook/addon-notes
  • Convert Accordion-story to Component Story Format (CSF)
  • Add support for addon-docs for each story using addParameters
  • Update sort logic

There are a couple of issues that this PR ran into, namely:

  • Components that don't have a displayName or prop types picked up by addons-docs
    • NumberInput
    • OverflowMenu
    • RadioButton
    • TextInput
    • Tooltip
  • Components that render prop type comments with HTML
    • TextArea
    • RadioTile
  • Stories that do not work
    • ToggleSkeleton
    • ToggleSmallSkeleton

@joshblack joshblack requested a review from a team as a code owner July 23, 2020 19:26
@joshblack joshblack requested review from tw15egan and aledavila July 23, 2020 19:26
@netlify
Copy link

netlify bot commented Jul 23, 2020 •
edited
Loading

Deploy preview for carbon-elements ready!

Built with commit 1eaff2e

https://deploy-preview-6532--carbon-elements.netlify.app

@netlify
Copy link

netlify bot commented Jul 23, 2020 •
edited
Loading

Deploy preview for carbon-components-react ready!

Built with commit 1eaff2e

https://deploy-preview-6532--carbon-components-react.netlify.app

@joshblack joshblack requested a review from a team as a code owner July 23, 2020 20:24
@joshblack
Copy link
Contributor Author

cc @tw15egan @aledavila should be good to go now!

aledavila
aledavila approved these changes Jul 27, 2020
View reviewed changes
Copy link
Contributor

@aledavila aledavila left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉 lgtm

@joshblack joshblack mentioned this pull request Jul 27, 2020
Closed
43 tasks
tw15egan
tw15egan approved these changes Jul 27, 2020
View reviewed changes
Copy link
Collaborator

@tw15egan tw15egan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉 lets goooo

@joshblack joshblack merged commit 8a99fc6 into carbon-design-system:master Jul 27, 2020
@joshblack joshblack deleted the docs/update-stories-to-component-story-format branch July 27, 2020 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aledavila aledavila aledavila approved these changes

@tw15egan tw15egan tw15egan approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@joshblack @tw15egan @aledavila